Carbon


StoreWindowIntoCollection

Header: MacWindows.h Carbon status: Supported

Stores data describing a window into a collection.

OSStatus StoreWindowIntoCollection (
    WindowRef window, 
    Collection collection
);
window

A pointer to the window to be stored.

collection

A reference to the collection into which the window is to be stored. You pass a reference to a previously created collection, such as that returned by the Collection Manager function NewCollection.

function result

A result code.

DISCUSSION

The StoreWindowIntoCollection function stores any window—including those not created by Mac OS 8.5 Window Manager calls—into the specified collection. The Window Manager does not empty the collection beforehand, so any existing items in the collection remain.

VERSION NOTES

This function is available with Mac OS 8.5 and later.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when WindowsLib 8.5 or later is installed. Exported by CarbonLib 1.0 and later and by WindowsLib 8.5 and later.


© 2000 Apple Computer, Inc. — (Last Updated 4/14/2000)